Platform Explorer / Nuxeo Platform 2023.22

Extension point suggesters

Documentation

Extension point for registering named suggester implementations and their parameters.

Suggester implementations should implement the "org.nuxeo.ecm.platform.suggestbox.service.Suggester" interface.

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-platform-suggestbox-core-2023.22.13.jar /OSGI-INF/suggestbox-suggesters-contrib.xml
    <extension point="suggesters" target="org.nuxeo.ecm.platform.suggestbox.service.SuggestionService">
    
        <suggester class="org.nuxeo.ecm.platform.suggestbox.service.suggesters.DocumentLookupSuggester" name="documentLookupByTitle">
          <parameters>
            <parameter name="providerName">DEFAULT_DOCUMENT_SUGGESTION</parameter>
            <parameter name="highlightFields">dc:title.fulltext,ecm:binarytext,dc:description.fulltext,ecm:tag,note:note.fulltext,file:content.name</parameter>
          </parameters>
        </suggester>
    
        <suggester class="org.nuxeo.ecm.platform.suggestbox.service.suggesters.UserGroupLookupSuggester" name="searchByUsersAndGroups">
          <parameters>
            <parameter name="userSuggestionsLimit">5</parameter>
            <parameter name="groupSuggestionsLimit">5</parameter>
            <parameter name="searchFields">fsd:dc_creator</parameter>
          </parameters>
        </suggester>
    
      </extension>